package v3

/*
详细中文注释 ChatGPT 4o
*/

import (
	"bytes"
	"fmt"
	"runtime"
	"strconv"
	"sync"
)

// 定义一个字节数组，用于匹配 goroutine ID 前缀
var goroutineSpace = []byte("goroutine ")

// 获取当前 goroutine 的 ID
func curGoroutineID() uint64 {
	b := make([]byte, 64)           // 创建一个 64 字节的缓冲区
	b = b[:runtime.Stack(b, false)] // 获取当前 goroutine 的堆栈信息
	// 去掉 "goroutine " 前缀，剩下的是 goroutine ID
	b = bytes.TrimPrefix(b, goroutineSpace)
	i := bytes.IndexByte(b, ' ') // 找到第一个空格的索引位置
	if i < 0 {
		panic(fmt.Sprintf("No space found in %q", b))
	}
	b = b[:i]                                      // 截取 goroutine ID 部分
	n, err := strconv.ParseUint(string(b), 10, 64) // 将字符串转换为 uint64
	if err != nil {
		panic(fmt.Sprintf("Failed to parse goroutine ID out of %q: %v", b, err))
	}
	return n
}

// 打印跟踪信息
func printTrace(id uint64, name string, line int, arrow string, indent int) {
	indents := ""
	for i := 0; i < indent; i++ {
		indents += "    " // 根据缩进等级生成缩进字符串
	}
	// 使用带颜色的格式打印信息
	fmt.Printf("\033[1;32mg[%05d]\033[0m:%s%s\033[1;32m%s\033[0m:%d\n", id, indents, arrow, name, line)
}

var mu sync.Mutex            // 互斥锁保护 map 的并发访问
var m = make(map[uint64]int) // 保存每个 goroutine 的缩进等级

// Trace 函数用于跟踪函数调用，返回一个在函数退出时调用的匿名函数
func Trace() func() {
	// 获取调用者的信息
	pc, _, line, ok := runtime.Caller(1)
	if !ok {
		panic("not found caller")
	}

	fn := runtime.FuncForPC(pc) // 获取函数对象
	name := fn.Name()           // 获取函数名称
	gid := curGoroutineID()     // 获取当前 goroutine ID

	mu.Lock()
	indents := m[gid]    // 获取当前 goroutine 的缩进等级
	m[gid] = indents + 1 // 增加缩进等级
	mu.Unlock()
	printTrace(gid, name, line, "->", indents+1) // 打印进入函数的跟踪信息
	return func() {
		mu.Lock()
		indents := m[gid]    // 获取当前 goroutine 的缩进等级
		m[gid] = indents - 1 // 减少缩进等级
		mu.Unlock()
		printTrace(gid, name, line, "<-", indents) // 打印退出函数的跟踪信息
	}
}

/*
代码说明：
curGoroutineID函数：

通过调用runtime.Stack获取当前goroutine的堆栈信息，然后解析出goroutine的ID。
printTrace函数：

打印格式化的跟踪信息，带有颜色和缩进，用于显示函数调用的层次结构。
Trace函数：

这是一个装饰器函数，用于跟踪函数的进入和退出。它获取调用者的信息，包括函数名和行号，增加当前goroutine的缩进等级，并返回一个在函数退出时调用的匿名函数，减少缩进等级并打印退出信息。
全局变量：

mu是一个互斥锁，用于保护并发访问map m。
m是一个map，保存每个goroutine的缩进等级。
这个代码可以用来调试和跟踪Go语言中的函数调用，特别是在并发环境下，能够帮助理解goroutine的执行顺序和调用层次。


*/
